

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The scrollableList module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The qt module" href="mod_pyamp_ui_qt.html" />
    <link rel="next" title="The baseView module" href="pyamp_ui_qt_baseView.html" />
    <link rel="prev" title="The styleSheet module" href="pyamp_ui_qt_styleSheet.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_baseView.html" title="The baseView module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_styleSheet.html" title="The styleSheet module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui.html" >The ui module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui_qt.html" accesskey="U">The qt module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.ui.qt.scrollableList">
<span id="the-scrollablelist-module"></span><h1>The scrollableList module<a class="headerlink" href="#module-pyamp.ui.qt.scrollableList" title="Permalink to this headline">¶</a></h1>
<p>The scrollableList module contains the ScrollableList class which provides
and implementation of the BaseWidget class to display a WidgetList within
a QScrollArea.</p>
<div class="section" id="the-scrollablelist-class">
<h2>The ScrollableList class<a class="headerlink" href="#the-scrollablelist-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-edee579c5d079799d480e584e0f56719a9f38de1.png" alt="Inheritance diagram of pyamp.ui.qt.scrollableList.ScrollableList" usemap="#inheritancedd2ac81346" class="inheritance"/>
<map id="inheritancedd2ac81346" name="inheritancedd2ac81346">
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="5,140,208,163"/>
<area shape="rect" href="pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView" title="pyamp.ui.qt.baseView.BaseView" alt="" coords="319,206,513,229"/>
<area shape="rect" href="pyamp_ui_qt_baseWidget.html#pyamp.ui.qt.baseWidget.BaseWidget" title="pyamp.ui.qt.baseWidget.BaseWidget" alt="" coords="446,273,665,296"/>
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="228,140,604,163"/>
<area shape="rect" href="#pyamp.ui.qt.scrollableList.ScrollableList" title="pyamp.ui.qt.scrollableList.ScrollableList" alt="" coords="438,340,673,363"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList">
<em class="property">class </em><tt class="descclassname">pyamp.ui.qt.scrollableList.</tt><tt class="descname">ScrollableList</tt><big>(</big><em>name=None</em>, <em>controller=None</em>, <em>mainWindow=None</em>, <em>logData=None</em>, <em>logColor=0</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList" title="Permalink to this definition">¶</a></dt>
<dd><p>The ScrollableList class creates a BaseWidget that contains a
QScrollArea which displays a WidgetList inside of the scroll area. This
allows a the user to scroll through the WidgetList to see previously added
widgets.</p>
<p>In order to fix the size of the scroll area, subclasses of ScrollableList
should set the <em>size</em> class property which is a QSize object.</p>
<ul class="simple">
<li>name &#8211; The name of the BaseWidget</li>
<li>controller &#8211; The controller for the BaseWidget</li>
<li>mainWindow &#8211; The main window</li>
<li>logData &#8211; The <a class="reference internal" href="../logging.html#pyamp.logging.LogData" title="pyamp.logging.LogData"><tt class="xref py py-class docutils literal"><span class="pre">pyamp.logging.LogData</span></tt></a> object</li>
<li>logColor &#8211; The color to use for logging</li>
</ul>
<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.addItem">
<tt class="descname">addItem</tt><big>(</big><em>item</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.addItem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.addItem" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an item to the ScrollabelList widget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.addWidget">
<tt class="descname">addWidget</tt><big>(</big><em>widget</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.addWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.addWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a widget to the ScrollableList widget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.clearWidgets">
<tt class="descname">clearWidgets</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.clearWidgets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.clearWidgets" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear all of the widgets from the ScrollableList.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.createElements">
<tt class="descname">createElements</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.createElements"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.createElements" title="Permalink to this definition">¶</a></dt>
<dd><p>Override the BaseWidget createElements class.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.getScrollArea">
<tt class="descname">getScrollArea</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.getScrollArea"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.getScrollArea" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the QScrollArea for this widget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.getWidgetList">
<tt class="descname">getWidgetList</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.getWidgetList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.getWidgetList" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the WidgetList for this ScrollabeList.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.horizontalPolicy">
<tt class="descname">horizontalPolicy</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.horizontalPolicy" title="Permalink to this definition">¶</a></dt>
<dd><p>The horizontalPolicy property contains the <a class="reference internal" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy" title="pyamp.ui.qt.scrollableList.ScrollBarPolicy"><tt class="xref py py-class docutils literal"><span class="pre">ScrollBarPolicy</span></tt></a>
for the horizontal scrollbar.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.margin">
<tt class="descname">margin</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.margin" title="Permalink to this definition">¶</a></dt>
<dd><p>The margin property contains the margin between all items in the list.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.scroll">
<tt class="descname">scroll</tt><big>(</big><em>amount</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.scroll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.scroll" title="Permalink to this definition">¶</a></dt>
<dd><p>Scroll the vertical scrollbar by the given amount.</p>
<ul>
<li><dl class="first docutils">
<dt>amount &#8211; The amount to scroll (negative being scrolling up, and</dt>
<dd><p class="first last">is positive scrolling down)</p>
</dd>
</dl>
</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.scrollTo">
<tt class="descname">scrollTo</tt><big>(</big><em>y=0</em><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.scrollTo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.scrollTo" title="Permalink to this definition">¶</a></dt>
<dd><p>Scroll to the given position.</p>
<ul class="simple">
<li>y &#8211; The y position to scroll to</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.scrollToBottom">
<tt class="descname">scrollToBottom</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.scrollToBottom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.scrollToBottom" title="Permalink to this definition">¶</a></dt>
<dd><p>Scroll to the bottom of the list.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.scrollToTop">
<tt class="descname">scrollToTop</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.scrollToTop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.scrollToTop" title="Permalink to this definition">¶</a></dt>
<dd><p>Scroll to the top of the list.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.size">
<tt class="descname">size</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.size" title="Permalink to this definition">¶</a></dt>
<dd><p>The size property contains the size of the scrollable list.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.sizeHint">
<tt class="descname">sizeHint</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollableList.sizeHint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.sizeHint" title="Permalink to this definition">¶</a></dt>
<dd><p>Override the QWidget sizeHint function to return the size of this
ScrollableList.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollableList.verticalPolicy">
<tt class="descname">verticalPolicy</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollableList.verticalPolicy" title="Permalink to this definition">¶</a></dt>
<dd><p>The verticalPolicy property contains the <a class="reference internal" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy" title="pyamp.ui.qt.scrollableList.ScrollBarPolicy"><tt class="xref py py-class docutils literal"><span class="pre">ScrollBarPolicy</span></tt></a>
for the vertical scrollbar.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-basewidget-class">
<h2>The BaseWidget class<a class="headerlink" href="#the-basewidget-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-028734b27dd4a63a8304368856b3a9d6bd1b3dd4.png" alt="Inheritance diagram of pyamp.ui.qt.scrollableList.BaseWidget" usemap="#inheritancef7eb2c686e" class="inheritance"/>
<map id="inheritancef7eb2c686e" name="inheritancef7eb2c686e">
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="5,140,208,163"/>
<area shape="rect" href="pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView" title="pyamp.ui.qt.baseView.BaseView" alt="" coords="319,206,513,229"/>
<area shape="rect" href="pyamp_ui_qt_baseWidget.html#pyamp.ui.qt.baseWidget.BaseWidget" title="pyamp.ui.qt.baseWidget.BaseWidget" alt="" coords="446,273,665,296"/>
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="228,140,604,163"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget">
<em class="property">class </em><tt class="descclassname">pyamp.ui.qt.scrollableList.</tt><tt class="descname">BaseWidget</tt><big>(</big><em>name=None</em>, <em>controller=None</em>, <em>mainWindow=None</em>, <em>logData=None</em>, <em>logColor=0</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>The BaseWidget class provides an implementation of the
<tt class="xref py py-class docutils literal"><span class="pre">amp.ui.qt.BaseView</span></tt> class designed to set up and create a
<tt class="xref py py-class docutils literal"><span class="pre">PyQt4.QtGui.QWidget</span></tt> object.</p>
<p>This class provides serveral functions which can be overridden by
subclasses to easily add features to the BaseWidget. These functions
are called in the following order during the set up process:</p>
<blockquote>
<ol class="arabic simple">
<li>configure()</li>
<li>configureLayout()</li>
<li>createElements()</li>
<li>setupConnections()</li>
</ol>
</blockquote>
<ul class="simple">
<li>name &#8211; The name of the BaseWidget</li>
<li>controller &#8211; The controller for the BaseWidget</li>
<li>mainWindow &#8211; The main window</li>
<li>logData &#8211; The <a class="reference internal" href="../logging.html#pyamp.logging.LogData" title="pyamp.logging.LogData"><tt class="xref py py-class docutils literal"><span class="pre">pyamp.logging.LogData</span></tt></a> object</li>
<li>logColor &#8211; The color to use for logging</li>
</ul>
<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.addElement">
<tt class="descname">addElement</tt><big>(</big><em>element</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.addElement" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an element to the main layout.</p>
<ul class="simple">
<li>element &#8211; The element to add</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.addElements">
<tt class="descname">addElements</tt><big>(</big><em>elements</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.addElements" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a list of elements to the main layout.</p>
<ul class="simple">
<li>elements &#8211; The list of elements</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.addItem">
<tt class="descname">addItem</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.addItem" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an item to the main layout.</p>
<ul class="simple">
<li>item &#8211; The item to add</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.addWidget">
<tt class="descname">addWidget</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.addWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a widget to the main layout.</p>
<ul class="simple">
<li>widget &#8211; The widget to add</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.clear">
<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove all of the child widgets and items currently for this
BaseWidget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.clearItems">
<tt class="descname">clearItems</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.clearItems" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear all the items from this BaseWidget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.clearWidgets">
<tt class="descname">clearWidgets</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.clearWidgets" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear all the widgets from this BaseWidget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.configure">
<tt class="descname">configure</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.configure" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the view.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.configureLayout">
<tt class="descname">configureLayout</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.configureLayout" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the layout for this view.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.createElements">
<tt class="descname">createElements</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.createElements" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the elements for this view. Return the list of widgets,
or items in the order that they should be added to the layout.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.createLayout">
<tt class="descname">createLayout</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.createLayout" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the main layout.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.getItems">
<tt class="descname">getItems</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.getItems" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of child items for this BaseWidget.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.getWidgets">
<tt class="descname">getWidgets</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.getWidgets" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of child widgets for this BaseWidget.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.layoutType">
<tt class="descname">layoutType</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.layoutType" title="Permalink to this definition">¶</a></dt>
<dd><p>The layoutType property contains the type of layout to use for this
Widget. It should be a value from the <tt class="xref py py-class docutils literal"><span class="pre">LayoutType</span></tt> class.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.paintEvent">
<tt class="descname">paintEvent</tt><big>(</big><em>_event</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.paintEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Override the paintEvent function to allow StylSheets to work for
this QWidget.</p>
<dl class="docutils">
<dt>Note this function was taken from the documentation of style sheets</dt>
<dd>for custom QWidget classes.</dd>
</dl>
<ul class="simple">
<li>_event &#8211; The QPaintEvent</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.setMargins">
<tt class="descname">setMargins</tt><big>(</big><em>left=None</em>, <em>top=None</em>, <em>right=None</em>, <em>bottom=None</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.setMargins" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the content margins for this widget&#8217;s layout.</p>
<ul class="simple">
<li>left &#8211; The left margin</li>
<li>top &#8211; The top margin</li>
<li>right &#8211; The right margin</li>
<li>bottom &#8211; The bottom margin</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.setSpacing">
<tt class="descname">setSpacing</tt><big>(</big><em>spacing</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.setSpacing" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the spacing between components in the layout.</p>
<ul class="simple">
<li>spacing &#8211; The spacing</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.setStyleSheet">
<tt class="descname">setStyleSheet</tt><big>(</big><em>styleSheet</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.setStyleSheet" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the style sheet for this widget.</p>
<ul class="simple">
<li>styleSheet &#8211; The StyleSheet</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.setupConnections">
<tt class="descname">setupConnections</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.setupConnections" title="Permalink to this definition">¶</a></dt>
<dd><p>Set up any connections this view requires.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.setupView">
<tt class="descname">setupView</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.setupView" title="Permalink to this definition">¶</a></dt>
<dd><p>Create and set up this view.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.BaseWidget.tabOrder">
<tt class="descname">tabOrder</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.BaseWidget.tabOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>The tabOrder property allows concrete widgets to set their tab order.
Each element in the list will be tab connected to the next element in
the list. The list will cycle around to the front so the final element
is tab connected to the first element.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-widgetlist-class">
<h2>The WidgetList class<a class="headerlink" href="#the-widgetlist-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-6a1188cd9a8c68c10c5781e02f9453d5ba7b5362.png" alt="Inheritance diagram of pyamp.ui.qt.scrollableList.WidgetList" usemap="#inheritanced8bb148186" class="inheritance"/>
<map id="inheritanced8bb148186" name="inheritanced8bb148186">
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="5,140,208,163"/>
<area shape="rect" href="pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView" title="pyamp.ui.qt.baseView.BaseView" alt="" coords="319,206,513,229"/>
<area shape="rect" href="pyamp_ui_qt_baseWidget.html#pyamp.ui.qt.baseWidget.BaseWidget" title="pyamp.ui.qt.baseWidget.BaseWidget" alt="" coords="446,273,665,296"/>
<area shape="rect" href="pyamp_ui_qt_widgetList.html#pyamp.ui.qt.widgetList.WidgetList" title="pyamp.ui.qt.widgetList.WidgetList" alt="" coords="455,340,656,363"/>
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="228,140,604,163"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.ui.qt.scrollableList.WidgetList">
<em class="property">class </em><tt class="descclassname">pyamp.ui.qt.scrollableList.</tt><tt class="descname">WidgetList</tt><big>(</big><em>name=None</em>, <em>controller=None</em>, <em>mainWindow=None</em>, <em>logData=None</em>, <em>logColor=0</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList" title="Permalink to this definition">¶</a></dt>
<dd><p>The WidgetList class defines a BaseWidget object that has the ability
to display a list of widgets vertically one after the other. This class
handles resizing the widget appropriately based on the widgets that
are in the list.</p>
<ul class="simple">
<li>name &#8211; The name of the BaseWidget</li>
<li>controller &#8211; The controller for the BaseWidget</li>
<li>mainWindow &#8211; The main window</li>
<li>logData &#8211; The <a class="reference internal" href="../logging.html#pyamp.logging.LogData" title="pyamp.logging.LogData"><tt class="xref py py-class docutils literal"><span class="pre">pyamp.logging.LogData</span></tt></a> object</li>
<li>logColor &#8211; The color to use for logging</li>
</ul>
<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.addItem">
<tt class="descname">addItem</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.addItem" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an item to the widget list.</p>
<ul class="simple">
<li>item &#8211; The item to add</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.addWidget">
<tt class="descname">addWidget</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.addWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a widget to this widget list.</p>
<ul class="simple">
<li>widget &#8211; The widget to add</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.clear">
<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear all the widgets from the list.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.setHorizontalRezizePolicy">
<tt class="descname">setHorizontalRezizePolicy</tt><big>(</big><em>policy</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.setHorizontalRezizePolicy" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the horizontal resize policy.</p>
<ul class="simple">
<li>policy &#8211; The new resize policy</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.setMargin">
<tt class="descname">setMargin</tt><big>(</big><em>margin</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.setMargin" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the margin for this widget list.</p>
<ul class="simple">
<li>margin &#8211; The margin to use</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.ui.qt.scrollableList.WidgetList.setVerticalResizePolicy">
<tt class="descname">setVerticalResizePolicy</tt><big>(</big><em>policy</em><big>)</big><a class="headerlink" href="#pyamp.ui.qt.scrollableList.WidgetList.setVerticalResizePolicy" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the vertical resize policy.</p>
<ul class="simple">
<li>policy &#8211; The new resize policy</li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-scrollbarpolicy-class">
<h2>The ScrollBarPolicy class<a class="headerlink" href="#the-scrollbarpolicy-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-7b6161b1c7168f48294dc266ca54b77ef615751c.png" alt="Inheritance diagram of pyamp.ui.qt.scrollableList.ScrollBarPolicy" usemap="#inheritanced9b9d937e1" class="inheritance"/>
<map id="inheritanced9b9d937e1" name="inheritanced9b9d937e1">
<area shape="rect" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy" title="pyamp.ui.qt.scrollableList.ScrollBarPolicy" alt="" coords="5,7,285,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.ui.qt.scrollableList.ScrollBarPolicy">
<em class="property">class </em><tt class="descclassname">pyamp.ui.qt.scrollableList.</tt><tt class="descname">ScrollBarPolicy</tt><a class="reference internal" href="../_modules/pyamp/ui/qt/scrollableList.html#ScrollBarPolicy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy" title="Permalink to this definition">¶</a></dt>
<dd><p>The ScrollBarPolicy class contains the policies which control
the visibility of a scrollbar.</p>
<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollBarPolicy.AlwaysOff">
<tt class="descname">AlwaysOff</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy.AlwaysOff" title="Permalink to this definition">¶</a></dt>
<dd><p>The scrollbar will never be displayed.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollBarPolicy.AlwaysOn">
<tt class="descname">AlwaysOn</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy.AlwaysOn" title="Permalink to this definition">¶</a></dt>
<dd><p>The scrollbar will always be displayed.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.ui.qt.scrollableList.ScrollBarPolicy.AsNeeded">
<tt class="descname">AsNeeded</tt><a class="headerlink" href="#pyamp.ui.qt.scrollableList.ScrollBarPolicy.AsNeeded" title="Permalink to this definition">¶</a></dt>
<dd><p>The scrollbar will be visible only when the all of the scroll area
cannot be viewed at once.</p>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The scrollableList module</a><ul>
<li><a class="reference internal" href="#the-scrollablelist-class">The ScrollableList class</a></li>
<li><a class="reference internal" href="#the-basewidget-class">The BaseWidget class</a></li>
<li><a class="reference internal" href="#the-widgetlist-class">The WidgetList class</a></li>
<li><a class="reference internal" href="#the-scrollbarpolicy-class">The ScrollBarPolicy class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_ui_qt_styleSheet.html"
                        title="previous chapter">The styleSheet module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pyamp_ui_qt_baseView.html"
                        title="next chapter">The baseView module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_ui_qt_scrollableList.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_baseView.html" title="The baseView module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_ui_qt_styleSheet.html" title="The styleSheet module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui.html" >The ui module</a> &raquo;</li>
          <li><a href="mod_pyamp_ui_qt.html" >The qt module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>